Add the ability to import/export users via CSV by jnptk · Pull Request #1971 · plone/plone.restapi

jnptk · 2026-01-12T15:18:22Z

As site administrator I can create Plone users by uploading a CSV file
As site administrator I can export all existing Plone users as CSV file
Update documentation
More tests!!

📚 Documentation preview 📚: https://plonerestapi--1971.org.readthedocs.build/

mister-roboto · 2026-01-12T15:18:32Z

@jnptk thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

src/plone/restapi/services/users/get.py

jnptk · 2026-01-16T16:36:26Z

DO NOT MERGE YET

Notes:

test_list_users_via_csv seems to be flaky
roles don't seem to be applied
location response header when multiple user are created?

stevepiercy

Minor docs tweaks. Looking good so far. Thank you!

docs/source/endpoints/users.md

Co-authored-by: Steve Piercy <web@stevepiercy.com>

stevepiercy

Docs LGTM so far.

stevepiercy

This looks really good. Thank you! Please see my suggestions.

https://plonerestapi--1971.org.readthedocs.build/en/1971/endpoints/users.html#create-users-via-csv

docs/source/endpoints/users.md

Co-authored-by: Steve Piercy <web@stevepiercy.com>

jnptk · 2026-01-28T09:33:55Z

While writing the docs, I noticed that the roles included in the request are not part of the response, I will investigate...

stevepiercy

Docs changes look great! I'm glad you caught the empty roles response. I missed that.

jnptk · 2026-01-29T14:45:20Z

@davisagli we set the Location header with the location of the newly created user, but in the case of a csv one might create more than one user. Should we set the header in this case or abandon it?

stevepiercy

Roles now appear in the response.

https://plonerestapi--1971.org.readthedocs.build/en/1971/endpoints/users.html#create-users-via-csv

Thank you!

davisagli

we set the Location header with the location of the newly created user, but in the case of a csv one might create more than one user. Should we set the header in this case or abandon it?

No, I don't think it makes sense to redirect to one particular user if multiple users were created.

docs/source/endpoints/users.md

src/plone/restapi/tests/http-examples/users_searched.resp

src/plone/restapi/tests/test_services_users.py

src/plone/restapi/batching.py

src/plone/restapi/services/users/get.py

src/plone/restapi/services/users/add.py

Co-authored-by: David Glick <david@glicksoftware.com>

docs/source/endpoints/users.md

Co-authored-by: jnptk <110389276+jnptk@users.noreply.github.com>

davisagli

I think this is just about ready!

src/plone/restapi/tests/http-examples/users_add_csv_format.resp

jnptk · 2026-02-13T14:59:02Z

@jenkins-plone-org please run jobs

davisagli · 2026-02-24T04:47:00Z

@jenkins-plone-org please run jobs

add the ability to export users as csv file

e0c70e7

jnptk marked this pull request as draft January 12, 2026 15:18

jnptk changed the title ~~Add the ability to import/export users as csv file~~ Add the ability to import/export users via CSV Jan 13, 2026

jnptk added 2 commits January 15, 2026 15:10

Add support for importing users from a CSV file

f9f3432

Add changelog entry

f543cf2

jnptk requested a review from davisagli January 15, 2026 14:12

Merge branch 'main' into users-import/export

87aa161

jnptk marked this pull request as ready for review January 15, 2026 14:15

davisagli reviewed Jan 16, 2026

View reviewed changes

src/plone/restapi/services/users/get.py Outdated Show resolved Hide resolved

jnptk added 6 commits January 16, 2026 14:06

Don't make Users expandable, fixes the tests

f95684c

Remove adapter from zcml

4e2ccc4

Add error messages

fbca829

Set correct response headers

ae0784f

Run tests

0355fb1

Document GET method

c8db031

jnptk added 2 commits January 16, 2026 17:44

Document POST method

45a7e4b

Add tests for GET method

2e42fa5

stevepiercy requested changes Jan 17, 2026

View reviewed changes

docs/source/endpoints/users.md Outdated Show resolved Hide resolved

docs/source/endpoints/users.md Outdated Show resolved Hide resolved

Apply suggestions from code review

4eb58a1

Co-authored-by: Steve Piercy <web@stevepiercy.com>

stevepiercy reviewed Jan 17, 2026

View reviewed changes

jnptk added 8 commits January 22, 2026 11:52

Sort users by username if fullname is not set

6f73ad2

Explicitly return 201 on user creation

ed1fb27

Explicitly get user by username

d90d483

Update users get examples

e4e541a

Get file through http body

a91d62f

Send file through body in users test

9aa4d6b

Fix tests to expect an extra registry record

f42f534

Remove breakpoint

0efb051

stevepiercy requested changes Jan 27, 2026

View reviewed changes

docs/source/endpoints/users.md Outdated Show resolved Hide resolved

docs/source/endpoints/users.md Outdated Show resolved Hide resolved

docs/source/endpoints/users.md Outdated Show resolved Hide resolved

docs/source/endpoints/users.md Outdated Show resolved Hide resolved

jnptk and others added 2 commits January 28, 2026 09:10

Apply suggestions from code review

317ed83

Co-authored-by: Steve Piercy <web@stevepiercy.com>

Move resp below req & update CSV example

c02e49e

stevepiercy approved these changes Jan 28, 2026

View reviewed changes

Fix roles not being applied & update tests

713f3ec

stevepiercy approved these changes Jan 29, 2026

View reviewed changes

Merge branch 'main' into users-import/export

c032ad4

davisagli requested changes Jan 30, 2026

View reviewed changes

Apply suggestions from code review

4caec07

Co-authored-by: David Glick <david@glicksoftware.com>

jnptk commented Feb 3, 2026

View reviewed changes

docs/source/endpoints/users.md Outdated Show resolved Hide resolved

davisagli and others added 8 commits February 4, 2026 20:27

Update docs/source/endpoints/users.md

5e5275e

Co-authored-by: jnptk <110389276+jnptk@users.noreply.github.com>

Error message

5c15ca7

Merge Users & UsersGet

d17e2ea

Add changelog entry for HypermediaBatch fix

c7ab834

Create CSV in-memory instead of temporary on disk

95b821f

Remove location header for csv reply

f3e2051

Fix tests

a938578

Rewrite test_get_users_filtering

5e96dae

jnptk requested a review from davisagli February 10, 2026 12:48

davisagli reviewed Feb 11, 2026

View reviewed changes

src/plone/restapi/tests/http-examples/users_add_csv_format.resp Outdated Show resolved Hide resolved

Return dict with items array on user creation

759a6b7

jnptk mentioned this pull request Feb 13, 2026

Update users controlpanel to work with new response format plone/volto#7895

Merged

Merge branch 'main' into users-import/export

c383d2c

davisagli approved these changes Feb 24, 2026

View reviewed changes

davisagli merged commit 0dc0aaf into main Feb 24, 2026
17 checks passed

davisagli deleted the users-import/export branch February 24, 2026 16:04

Uh oh!

Conversation

jnptk commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mister-roboto commented Jan 12, 2026

Uh oh!

Uh oh!

jnptk commented Jan 16, 2026

Uh oh!

stevepiercy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

stevepiercy left a comment

Choose a reason for hiding this comment

Uh oh!

stevepiercy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jnptk commented Jan 28, 2026

Uh oh!

stevepiercy left a comment

Choose a reason for hiding this comment

Uh oh!

jnptk commented Jan 29, 2026

Uh oh!

stevepiercy left a comment

Choose a reason for hiding this comment

Uh oh!

davisagli left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davisagli left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jnptk commented Feb 13, 2026

Uh oh!

davisagli commented Feb 24, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jnptk commented Jan 12, 2026 •

edited

Loading